Library: VoltScriptJSONConverter

VoltScriptJSONConverter.VoltScriptJSONConverter

JSON Serialization and Deserialization for VoltScript.
The global variables exist so Execute statements can be used. Do not set or read values manually.

Library Summary

Script Creator Paul Withers
Uses Libraries ../libs/VoltScriptLogging, ../libs/VoltScriptTesting
Uses VSE JsonVSE

Script Creator	Paul Withers
Uses Libraries	../libs/VoltScriptLogging, ../libs/VoltScriptTesting
Uses VSE	JsonVSE

Variables

Name Type Comment

Public samsaraFunctionsTouched As Variant
Public samsaraObj As Variant
Public samsaraParamVals As Variant
Public samsaraVal As Variant

Name	Type	Comment
`Public samsaraFunctionsTouched`	`As Variant`
`Public samsaraObj`	`As Variant`
`Public samsaraParamVals`	`As Variant`
`Public samsaraVal`	`As Variant`

Classes Summary

AbstractJsonConstructor	Abstract class for calling any constructor that takes arguments when creating an object.
AbstractJsonConverter	Base Converter to convert JSON to VoltScript datatype or object and vice versa. This is an abstract class only, a derived class must be used.
AbstractJsonFunctionConverter	Custom Converter to convert between a JSON value or values and VoltScript datatype or objects, using a specific sub or function in the underlying class. Used as the abstract class for JsonGetterConverter and JsonSetterConverter.
ConverterParam	Class to hold details from which to extract a parameter for a setter or constructor.
JsonArrayConverter	Custom converter to convert a JSON value to VoltScript array
JsonBasicObjectArrayConverter	Custom converter to convert a JSON value to an array of VoltScript objects, potentially using passed JsonConversionHelper.
JsonBasicObjectConverter	Custom converter to convert a JSON value to a VoltScript object, potentially using a passed JsonConversionHelper
JsonConversionHelper	Helper class for performing the serialization / deserialization
JsonConversionHolder	Holder object for temporary output of serialization / deserialization
JsonCustomConstructor	Base implementation of AbstractJsonConstructor for constructors that take parameters.
JsonGetterConverter	Custom getter converter
JsonNoArgsConstructor	Base implementation of AbstractJsonConstructor for empty constructors
JsonScalarConverter	Cusom Converter to convert a JSON value to VoltScript scalar. This is used as the default for any conversion.
JsonSetterConverter	Custom Converter to convert between a JSON value or values and VoltScript datatype or objects, using a specific sub or function in the underlying class. During deserialization, the relevant JSON objects will then be removed from the parent JSON object, to ensure they are not re-processed.

Method Summaries

`loadLogWritersFromJson(context As String) As Variant`
`DebugPrint_Samsara(msg As String)`
`extractParam(source As JsonObject, idex As Integer, currParam As ConverterParam, converters List As AbstractJsonConverter)`
`samsaraTouchFunction(functionName As String)`

Methods Detail

loadLogWritersFromJson

Public Function loadLogWritersFromJson(context As String) As Variant
idx	Argument	Data Type	Attributes	Comments
1	context	String		String of JSON or path to file

Throws Exceptions
Message	Error Code	Comments
Invalid JSON string or file	1502

DebugPrint_Samsara

Public Sub DebugPrint_Samsara(msg As String)
Prints a message to the console, if running with the debug flag. The debug flag is a private global variable, enabled by calling JsonConversionHelper.enableDebug(). Typically used to log key steps or data in the process flow.
idx	Argument	Data Type	Attributes	Comments
1	msg	String		String to print

Code Sample
%REM Prints "Starting serialize" if debugging is enabled by calling enableDebug on a JsonConversionHelper. %END REM Call debugPrint_Samsara("Starting serialize")

extractParam

Public Sub extractParam(source As JsonObject, idex As Integer, currParam As ConverterParam, converters List As AbstractJsonConverter)
Extracts a parameter to a specific index of SamsaraParamVals, using a ConverterParam and list of converters.
idx	Argument	Data Type	Attributes	Comments
1	source	JsonObject		JsonObject from which to extract parameters for a function
2	idex	Integer		index of parameters into which to extract the value
3	currParam	ConverterParam		ConverterParam object containing default value
4	converters	AbstractJsonConverter	List	List of AbstractSamsaraConverters to use to convert the value

Code Sample
%REM The following code is from JsonSetterConverter.loadParamValuesForJsonObject. Loops through Me.params and constructs a corresponding Variant array of values. If the currParam's label exists in the parent JSON object (source), it is extracted. If a converter exists for that label, it will be used from the converters array. If the currParam's label does not exist in the parent JSON object, the currParam's default will be used instead. %END REM Dim currParam as CoverterParam Dim i as Integer For i = 0 to UBound(Me.params) Set currParam = Me.params(i) Select Case currParam.paramType Case "Parent": Call extractParam(source, i, currParam, converters) End Select Next

samsaraTouchFunction

Public Sub samsaraTouchFunction(functionName As String)
Logs a function as encountered, if running with the debug flag
idx	Argument	Data Type	Attributes	Comments
1	functionName	String		Function being touched

Code Sample
%REM If running in debug mode, adds the passed string ("resetSamsaraGlobals") to SamsaraFunctionsTouched variant array %END REM Call samsaraTouchFunction("resetSamsaraGlobals")

Library VoltScriptJSONConverter

VoltScriptJSONConverter.VoltScriptJSONConverter

Library Summary

Variables

Classes Summary

Method Summaries

Methods Detail

loadLogWritersFromJson

DebugPrint_Samsara

extractParam

samsaraTouchFunction